docs(sdk): expand BulkDecrypt section with options, error handling, and best practices#271
docs(sdk): expand BulkDecrypt section with options, error handling, and best practices#271marythought wants to merge 2 commits intomainfrom
Conversation
📝 WalkthroughWalkthroughThis is a documentation update to the TDF SDK docs that enhances explanations for Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request enhances the TDF SDK documentation by adding detailed explanations for BulkDecrypt and PrepareBulkDecrypt, including their performance benefits, configuration options, and error handling mechanisms. Additionally, it updates the OpenAPI specifications for policy namespaces to introduce sorting capabilities for namespace listings, defining new schemas for sort direction and field types. I have no feedback to provide as there are no review comments to address.
|
📄 Preview deployed to https://opentdf-docs-pr-271.surge.sh |
…nd best practices Add performance tip explaining why BulkDecrypt is preferable to looping LoadTDF, document all BulkDecryptOption functions (WithBulkKasAllowlist, WithBulkIgnoreAllowlist, WithTDFType, WithTDF3DecryptOptions), expand the error handling section to explain the partial-failure model and FromBulkErrors usage, and add prose explaining when/why to use PrepareBulkDecrypt. Also updates vendored OpenAPI specs (namespaces, selectors). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
marythought
force-pushed
the
DSPX-2625-bulkdecrypt-docs
branch
from
5f6936d to
3eff40a
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/sdks/tdf.mdx (1)
585-594: Add direct links inWithTDF3DecryptOptionsrow for faster lookup.Nice coverage of options. Consider linking readers straight to the detailed option docs from this row.
✏️ Proposed doc tweak
-| `WithTDF3DecryptOptions(opts...)` | Pass additional reader options (e.g., session key, assertion verification) through to each TDF3 decryptor. These are the same options accepted by `LoadTDF`. | +| `WithTDF3DecryptOptions(opts...)` | Pass additional reader options (e.g., session key, assertion verification) through to each TDF3 decryptor. These are the same options accepted by [`LoadTDF`](`#loadtdf`). See [Decrypt Options](`#decrypt-options`). |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/sdks/tdf.mdx` around lines 585 - 594, Update the table row for WithTDF3DecryptOptions to include direct hyperlinks to the detailed option docs for TDF3 decryptors and the LoadTDF function so readers can jump straight to full option descriptions; specifically add links from the "WithTDF3DecryptOptions(opts...)" text to the LoadTDF API docs and the TDF3 decryptor/options reference (the same docs that describe session key and assertion verification), ensuring anchor text still mentions WithTDF3DecryptOptions and LoadTDF so maintainers can find and verify the change easily.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/sdks/tdf.mdx`:
- Around line 585-594: Update the table row for WithTDF3DecryptOptions to
include direct hyperlinks to the detailed option docs for TDF3 decryptors and
the LoadTDF function so readers can jump straight to full option descriptions;
specifically add links from the "WithTDF3DecryptOptions(opts...)" text to the
LoadTDF API docs and the TDF3 decryptor/options reference (the same docs that
describe session key and assertion verification), ensuring anchor text still
mentions WithTDF3DecryptOptions and LoadTDF so maintainers can find and verify
the change easily.
1 participant
Summary
BulkDecryptis preferable to loopingLoadTDF(batches KAS rewrap requests to reduce round-trips)BulkDecryptOptionfunctions:WithBulkKasAllowlist,WithBulkIgnoreAllowlist,WithTDFType,WithTDF3DecryptOptionsFromBulkErrorsusagePrepareBulkDecrypt(obligations inspection, conditional decryption, monitoring)Source material:
platform/sdk/bulk.goTest plan
🤖 Generated with Claude Code
Summary by CodeRabbit